focusPattern

Type

property

Summary

Specifies the pattern used for an object's outline when it has the insertion point or is active focused.

Syntax

set the focusPattern of <object> to {<patternNumber> | <imageID> | empty}

Description

Use the focusPattern property to specify the pattern used for the outline around an active (focused) control.

Pattern images can be color or black-and-white.

Cross-platform note

To be used as a pattern on Mac OS systems, an image must be 128x128 pixels or less, and both its height and width must be a power of 2. To be used on Windows and Unix systems, height and width must be divisible by 8. To be used as a fully cross-platform pattern, both an image's dimensions should be one of 8, 16, 32, 64, or 128.

The focusPattern of controls is drawn starting at the control's upper right corner: if the control is moved, the pattern does not shift.

Setting the focusPattern of an object to empty allows the focusPattern of the object's owner to show through. Use the effective keyword to find out what color is used for the object, even if its own focusPattern is empty.

The setting of the focusPattern property has different effects, depending on the object type:

• The focusPattern of a stack, card, or group determines the focusPattern of each object in the stack, card, or group that does not have its own focusPattern.

• The focusPattern of a button is used to outline the button when it is focused. If the button's style is menu, or if the button's traversalOn property is false, the focusPattern has no effect.

• The focusPattern of a field or scrollbar is used to outline the object when it is focused. If the object's traversalOn property is false, the focusPattern has no effect.

• The focusPattern of a graphic, image, player, audioClip, videoClip, or EPS object has no effect.

If an object's focusPattern is set, the pattern is shown instead of the color specified by the focusColor.

The focusPattern property has no effect if the lookAndFeel property is set to Macintosh.

Examples

set the focusPattern of this stack to 2215

Related

function: stacks

glossary: object, property, EPS, Windows, object type, insertion point, focus, Mac OS, keyword, active control, Unix, current stack, explicit focus

keyword: effective, field, image, button, card, scrollbar, player, graphic, control

object: videoClip, button, stack, audioClip

property: pixels, owner, height, style, width, focusColor, lookAndFeel, traversalOn

command: focus, group

Compatibility and Support

Introduced

LiveCode 1.0

OS

mac

windows

linux

ios

android

Platforms

desktop

server

mobile